Skip to content

docs(core): document skipPluginEval option in README - #2997

Open
vadyvas wants to merge 3 commits into
mainfrom
docs/skip-plugin-eval-option
Open

docs(core): document skipPluginEval option in README#2997
vadyvas wants to merge 3 commits into
mainfrom
docs/skip-plugin-eval-option

Conversation

@vadyvas

@vadyvas vadyvas commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

What/Why/How?

Documents the skipPluginEval option of loadConfig in the public openapi-core README.

Reference

#2987 (comment)

Testing

Screenshots (optional)

Check yourself

  • This PR follows the contributing guide
  • All new/updated code is covered by tests
  • Core code changed? - Tested with other Redocly products (internal contributions only)
  • New package installed? - Tested in different environments (browser/node)
  • Documentation update has been considered

Security

  • The security impact of the change has been considered
  • Code follows company security practices and guidelines

@vadyvas
vadyvas requested a review from tatomyr July 31, 2026 10:30
@vadyvas
vadyvas requested a review from a team as a code owner July 31, 2026 10:30
@changeset-bot

changeset-bot Bot commented Jul 31, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: b459e61

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions

github-actions Bot commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Performance Benchmark (Lower is Faster)

CLI Version Bundle Lint Check Config
cli-latest ▓ 1.00x (Fastest) ▓ 1.03x ± 0.01 ▓ 1.00x (Fastest)
cli-next ▓ 1.01x ± 0.01 ▓ 1.00x (Fastest) ▓ 1.01x ± 0

Comment thread packages/core/README.md Outdated
Comment on lines +184 to +186

With `skipPluginEval`, `config.plugins` contains only the absolute paths of the referenced plugins, so use it to find out which plugin files a config points to without running their code.
In this mode `extends` is kept as authored, because presets live in plugin code: neither plugin nor built-in presets are resolved, and the root config isn't merged into the `apis` entries.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's no such thing as config.plugins. Just describe the use case and minimal technical details.

@github-actions

Copy link
Copy Markdown
Contributor

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 77.06% (🎯 77%) 11385 / 14774
🔵 Statements 77.17% (🎯 77%) 12169 / 15769
🔵 Functions 81.51% (🎯 81%) 2310 / 2834
🔵 Branches 70.75% (🎯 70%) 8327 / 11769
File CoverageNo changed files found.
Generated in workflow #11047 for commit b459e61 by the Vitest Coverage Report Action

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants